/************************************
*  Copyright (C) 2010 Julien MOTTIN.
*  Contact: julien.mottin@gueydan.eu
*
*  This file is part of Gueydan.
*
*  Gueydan is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  Gueydan is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with Gueydan.  If not, see <http://www.gnu.org/licenses/>.
*
*************************************/
#ifndef MASHSTEP_H
#define MASHSTEP_H

// Local
#include "duration.h"
#include "volume.h"
#include "temperature.h"
#include "beerxmlobject.h"

// QtCore
#include <QString>

enum MashStepType
{
    MSTInfusion = 0,
    MSTTemperature,
    MSTDecoction
};

class QDomNode;

class MashStep : public BeerXMLObject
{
    Q_OBJECT;
    
public:

    // Standard Constructors with all mandatory fields
    MashStep(const QString &iName,
         const int iVersion,
         const MashStepType iType,
         const Temperature &iStepTemp,
         const Duration &iStepDuration,
         const Volume &iInfuseAmount = 0.0);

    // empty Ctor
    MashStep();

    // Dtor
    ~MashStep();

    // Conveniance Operators
    bool operator==(const MashStep &iOther) const;
    bool operator!=(const MashStep &iOther) const;

    /*
    * XML IO
    * returns :
    *   - 0 : Success
    *   - 1 : Invalid XML
    */
    int CreateFromXMLNode(const QDomNode &iNode);
    int ToXMLNode(QDomNode &iParentNode) const;

public:

    // Internal data
    MashStepType    _Type;
    Temperature     _StepTemp;
    Duration        _StepTime;
    Volume          _InfuseAmount;
    Duration        _RampTime;
    Temperature     _EndTemp;

private:
    MashStep(const MashStep &);
    MashStep & operator=(const MashStep &);
};

#endif // MASHSTEP_H
